Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codespell support: config + workflow to catch new typos, let it fix some #1392

Merged
merged 5 commits into from
May 7, 2024

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Jan 24, 2024

Description of the Change

https://github.com/codespell-project/codespell is great to catch typos

Let me know if needs changelog entry etc

Checklist

  • PR only contains one change (considered splitting up PR)
  • unit-test added
  • documentation updated
  • CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS

@n2ygk n2ygk self-requested a review February 27, 2024 17:59
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.56%. Comparing base (560f84d) to head (d77c471).
Report is 5 commits behind head on master.

❗ Current head d77c471 differs from pull request most recent head 0ca5eee. Consider uploading reports for the commit 0ca5eee to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1392   +/-   ##
=======================================
  Coverage   97.56%   97.56%           
=======================================
  Files          32       32           
  Lines        2132     2132           
=======================================
  Hits         2080     2080           
  Misses         52       52           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.pre-commit-config.yaml Outdated Show resolved Hide resolved
tests/test_implicit.py Outdated Show resolved Hide resolved
@yarikoptic yarikoptic marked this pull request as draft February 28, 2024 00:41
@n2ygk
Copy link
Member

n2ygk commented Feb 28, 2024

@yarikoptic is this still a draft?

@yarikoptic
Copy link
Contributor Author

I moved it into draft since was experimenting with fixing that typo in a url in a test -- tests pass so it is great -- we can just fix the test. Also we verified that pre-commit catches typos -- I will remove dedicated workflow.
I will rebase/squash that change now to clean up history a little... force pushed -- should be all good and neat now ;)

@yarikoptic yarikoptic marked this pull request as ready for review February 28, 2024 15:11
Copy link
Member

@n2ygk n2ygk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this. I'm a little uncomfortable with changing names of variables in code (split -> splitted) but I guess in this case it's not a problem.

Please add yourself to AUTHORS

yarikoptic added 4 commits May 7, 2024 14:02
Includes also squashed

- [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

- Unfortunately due to bug in codespell we need to duplicate some skipped paths for pre-commit config
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@n2ygk n2ygk force-pushed the enh-codespell branch from d77c471 to a7f62af Compare May 7, 2024 18:02
@n2ygk n2ygk merged commit b1a2bb3 into jazzband:master May 7, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants